init

fun init()(source)

Initialize CouchbaseLite library. Unlike the Couchbase Lite Java SDK, this method is optional to call before using CouchbaseLite. The no-parameter CouchbaseLite.init() will be called automatically by default.

This method expects the current directory to be writeable and will throw a CouchbaseLiteError if it is not. Use init(boolean, File, File) to specify alternative root and scratch directories.

Throws

on initialization failure


@Internal(value = "This interface is not part of the public API")
fun init(debug: Boolean)(source)

Initialize CouchbaseLite library. Unlike the Couchbase Lite Java SDK, this method is optional to call before using CouchbaseLite. The no-parameter CouchbaseLite.init() will be called automatically by default.

This method expects the current directory to be writeable and will throw a CouchbaseLiteError if it is not. Use init(boolean, File, File) to specify alternative root and scratch directories.

Debugging mode is not supported for client code. Please use it only when advised to do so by Couchbase Support Engineering

Parameters

debug

true if debugging (Unsupported)

Throws

on initialization failure


@Internal(value = "This interface is not part of the public API")
fun init(debug: Boolean, rootDir: File, scratchDir: File)(source)

Initialize CouchbaseLite library. Unlike the Couchbase Lite Java SDK, this method is optional to call before using CouchbaseLite. The no-parameter CouchbaseLite.init() will be called automatically by default.

This method allows specifying a default root directory for database files, and the scratch directory used for temporary files (the native library, etc.). Both directories must be writable by this process.

Debugging mode is not supported for client code. Please use it only when advised to do so by Couchbase Support Engineering

Parameters

debug

true if debugging (Unsupported)

rootDir

default directory for databases

scratchDir

scratch directory for SQLite

Throws

on initialization failure